From IQsimWiki
XIQS Get Price Plan Topup Info - Price Plan Management
| Description
|
getXIQSPPTopupInfo ( Long id_priceplan )
Get from Price Plan object Topup parameters
|
| Parameters
|
|
Long id_priceplan
Price Plan Id
|
| Return Values
|
NOTE:
List of Topup parameters for specified Price Plan object
List List of Price Plan objects
Integer topmode - Recharge mode:
0 - Manual
1 - Automatic
2 - By Allocation Rule
Integer topmethod - Recharge SIM vie:
0 - IVR
1 - SMS
2 - USSD
3 - TRANSFER SIM
4 - USSD SMS
5 - CALL SMS
6 - SMS FLASH
7 - USSD FLASH
8 - SMS STANDARD
9 - WEB RECHARGE - Tranglo
10 - WEB RECHARGE - Tellus
11 - WEB RECHARGE - Paydirek
Integer topsmswait - Requirement for last SMS:
0 - None
1 - Notification
2 - SMS Replay
Long id_transferplan - Transfer Plan Id
Integer topfor - Recharge SIM for:
0 - Call
1 - SMS
2 - Call & SMS
Long remainsec - Recharge SIM on remaining call credit
Long remainsmsnb - Recharge SIM on remaining SMS number
String topnum - Recharge IVR/SMS Server number / USSD Script Command
String topscript - Recharge IVR Script / SMS Message
String ackivrnum - Confirmation IVR/SMS Server number / Supplementary USSD Script for Confirmation
String ackivrnum - Confirmation IVR/SMS Server number / Supplementary USSD Script for Confirmation
String ackivrscript - IVR Script/SMS message for Confirmation
Integer topactivsim - Reactive SIM after recharge flag
Integer topchkcredit - Check credit after recharge flag
Integer activmode - Activation mode:
0 - Manual
1 - Automatic
2 - By Allocation Rule
Integer activaction - Activation action:
0 - Sim card
1 - Promotion
Integer activchkcredit - For Activation action Promotion, Check credit after activation flag
Integer activpromoscript - For Activation action Promotion, Promotion Scheduler script
Integer activmethod - Activation method:
0 - IVR
1 - SMS
2 - USSD
Integer activsmswait - For Activation method SMS, Requirement for Last SMS:
0 - None
1 - Notification
2 - SMS Replay
String activnum - Depending on Activation method:
- Activation number for IVR and SMS
- Activation USSD command for USSD
Can contain any of the following characters '1'..'9' '*' '#' '+', but also "%n" to specify simcard called number and ',' to separate USSD menu choices
String activscript - Activation script for IVR and SMS Activation methods, depending on Activation method it can contain:
- For IVR any of the following characters '1'..'9' '*' '#' '+', but also "%n" to specify simcard called number, '.' meaning pause of 1 sec and ';' meaning pause of 5 sec
- For SMS any text, "%n" to specify simcard called number
Error Data structure ( Error Management )
Possible failure code returns
*ERR_OBJ_NOT_FOUND (404) ERR_MSG_PPLAN_NOT_FOUND
*ERR_UNAUTHORIZED (401) ERR_MSG_OBJ_NOT_OWNED
*ERR_SRV_INTERNAL (500) ERR_MSG_NO_DB
|
